/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.common;

import org.balisunrise.common.listeners.EntityListListener;
import java.io.Serializable;
import java.util.List;

/**
 * Este Inteface é responsável por armazenar uma lista de entidades.
 * É possível adicionar entidades a lista ou adicionar uma lista de entidades.
 * É possível ler as entidades da lista.
 * A Interface ainda dispara eventos de quando uma nova entidade ou lista de
 * entidades é adicionada.
 * @author Glauco
 * @version 1.0
 */
public interface EntityList extends Basic{

    /**
     * Adiciona uma entidade a lista.
     *
     * @param entity
     */
    public void addEntity(Serializable entity);

    /**
     * Adiciona uma lista de entidades.
     *
     * @param list
     */
    public void addList(List<? extends Serializable> list);

    /**
     * Atruibui a lista de entidades. Este método faz com que a
     * lista das entidades seja sobrescrita.
     *
     * @param list
     */
    public void setList(List<? extends Serializable> list);

    /**
     * Retorna um Array com as todas as entidades da lista.
     */
    public Serializable[] getEntities();

    /**
     * Retorna uma entidade atravéz do indece dela na lista.
     *
     * @param index
     */
    public Serializable getEntityAt(int index);

    /**
     * Adiciona um listener.
     *
     * @param listener
     */
    public void addEntityListListener(EntityListListener listener);

    /**
     * Remove um listener pelo indece dele na lista de listeners.
     *
     * @param index
     */
    public EntityListListener removeEntityListener(int index);

    /**
     * Remove um listener da lista de listeners.
     *
     * @param listener
     */
    public boolean removeEntityListener(EntityListListener listener);
    
    /**
     * Retorna um array com todos os listeners.
     */
    public EntityListListener[] getEntityListListeners();

}